新增“待办|未读”消息

更新时间:2022-12-27 16:26:57

接口说明

新增“待办/未读”消息

基本信息

请求方式: POST

请求路径:

https://prod.open-api.mysre.cn/xmlfjt/message/create

请求参数

参数名 参数位置 参数类型 必填 默认值 示例 描述
tenant_code query string
msg_id body string 39fb8f45-4892-dd5d-c9d6-ea1af7e79fc 长度小于50,格式不限,必须唯一
title body string 消息标题
content body string 消息内容
redirect_url body string 消息跳转链接
receiver_type body string USER USER(用户)/ORGANIZATION(组织)/PROJECT(项目)/ROLE(角色) 接收人类型
receiver_id body string 可填用户ID,或用户账号, 或手机号,具体看业务需求 接收人唯一标识
receiver_mobile body string 接收人手机,如果需要推送短信,则必填
source body string ZHULONG(筑龙) 消息来源
target body string OA(OA系统)/SUPER_APP(超级APP)/SMS(短信)/WECHAT_ACCOUNT(微信公众号)/DINGTALK(钉钉工作台通知) 消息接收对象类型, 支持使用字符串数组推送多个系统
target_data body string 消息接收对象目标数据,用来保存接收方需要的参数,json字符串
is_switch body number 0 是否转换receiver_id,0表示否,1表示是
classify body string 待办 待办/通知 消息类别
type body string TEXT TEXT/IMAGE 消息类型
remark body string 备注
custom body string 拓展字段,json字符串 需要推送业务数据
template_id body string 模板ID,业务需求使用模板消息时必填
status body string 0表示待办或已读,1表示已办或已读 消息状态

请求示例

    {
        "msg_id":"39fb8f45-4892-dd5d-c9d6-ea1af7e79fc",
        "title":"审批流程通知01",
        "content":"嗨,您的房产已绑定,请查看",
        "redirect_url":"https://www.baidu.com",
        "receiver_id":"39fae950-b1fc-7244-3ab7-474e209bb951",
        "receiver_type":"USER",
        "receiver_mobile":"13600000001"
        "source":"ZHULONG",
        "target":"OA",
        "target_data":{"xx":"xxxx"},
        "is_switch":0,
        "classify":"通知",
        "type":"TEXT",
        "remark":"备注123"
        "custom":{"xx":"xxxx"},
        "template_id":"123",
         "status": 0
    }

返回成功示例

  {
    "errcode": 0,
    "errMsg": "成功",
    "data": []
  }

返回参数说明(成功)

参数名 参数类型 描述
errcode number 错误码
errMsg string 错误提示信息
data array 数据集合

失败返回示例

  {
    "errcode": 9000,
    "errMsg": "租户code不能为空",
    "data": []
  }

返回参数说明(失败)

参数名 参数类型 描述
errcode number 错误码
errMsg string 错误提示信息
data array 数据集合

results matching ""

    No results matching ""